Skip to content

Clarify dotnet format is built into .NET SDK and remove SETUP.md reference#56

Merged
Chris-Wolfgang merged 5 commits intodevelopfrom
copilot/sub-pr-51-one-more-time
Feb 2, 2026
Merged

Clarify dotnet format is built into .NET SDK and remove SETUP.md reference#56
Chris-Wolfgang merged 5 commits intodevelopfrom
copilot/sub-pr-51-one-more-time

Conversation

Copy link
Contributor

Copilot AI commented Feb 2, 2026

Description

This PR addresses review feedback on PR #51 regarding dotnet format tool installation and documentation references. The changes clarify that the standalone dotnet-format tool was deprecated when dotnet format was integrated into the .NET 6 SDK in August 2021, and removes a broken documentation link.

Original PR: #51
Triggering review: #51 (comment)

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Refactor

How Has This Been Tested?

  • Tested format.ps1 script with preflight check to verify it works correctly
  • Verified all documentation changes render properly in Markdown
  • Confirmed dotnet format command works as expected without separate installation

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Screenshots (if applicable)

N/A - Documentation and script changes only

Additional context

Changes Made:

  1. README-FORMATTING.md - Added a Prerequisites section explaining that dotnet format is built into .NET 6+ SDK and no separate tool installation is needed

  2. format.ps1 - Added a preflight check that verifies dotnet format is available and provides helpful error messaging if the SDK is not installed

  3. .github/workflows/pr.yaml - Added a comment clarifying that dotnet format is built into the .NET 6+ SDK

  4. README.md - Removed the broken reference to SETUP.md and replaced it with a link to CONTRIBUTING.md

Security Summary

No vulnerabilities were introduced or discovered. CodeQL security scan passed with 0 alerts.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI mentioned this pull request Feb 2, 2026
14 tasks
Copilot AI requested a review from Chris-Wolfgang February 2, 2026 22:55
@Chris-Wolfgang
Copy link
Owner

@copilot retry working on this PR

Copilot AI and others added 3 commits February 2, 2026 23:06
Co-authored-by: Chris-Wolfgang <210299580+Chris-Wolfgang@users.noreply.github.com>
Co-authored-by: Chris-Wolfgang <210299580+Chris-Wolfgang@users.noreply.github.com>
Co-authored-by: Chris-Wolfgang <210299580+Chris-Wolfgang@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 2, 2026

@copilot retry working on this PR

I've addressed the review feedback regarding dotnet format and the SETUP.md reference. The changes clarify that dotnet format has been built into the .NET SDK since .NET 6 (August 2021) and doesn't require separate installation. Commit: 9934a2f

Copilot AI changed the title [WIP] WIP Address feedback from review on develop pull request Clarify dotnet format is built into .NET SDK and remove SETUP.md reference Feb 2, 2026
@Chris-Wolfgang Chris-Wolfgang marked this pull request as ready for review February 2, 2026 23:36
Copilot AI review requested due to automatic review settings February 2, 2026 23:36
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR clarifies documentation and tooling around the dotnet format command by explaining that it has been built into the .NET SDK since version 6.0 and requires no separate installation. The changes improve developer experience by removing broken documentation references and adding helpful error messages.

Changes:

  • Added Prerequisites section to formatting documentation explaining dotnet format is built into .NET 6+ SDK
  • Enhanced format.ps1 script with preflight check to verify dotnet format availability
  • Fixed broken SETUP.md reference in README by replacing it with link to CONTRIBUTING.md

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
README-FORMATTING.md Added Prerequisites section clarifying dotnet format is built-in and deprecated standalone tool
format.ps1 Added preflight validation check with helpful error messaging for missing .NET SDK
README.md Replaced broken SETUP.md link with valid CONTRIBUTING.md reference
.github/workflows/pr.yaml Added inline comment documenting that dotnet format is built into SDK

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@Chris-Wolfgang Chris-Wolfgang merged commit dad8782 into develop Feb 2, 2026
1 check passed
@Chris-Wolfgang Chris-Wolfgang deleted the copilot/sub-pr-51-one-more-time branch February 2, 2026 23:40
Copilot AI requested a review from Chris-Wolfgang February 2, 2026 23:41
Copilot stopped work on behalf of Chris-Wolfgang due to an error February 2, 2026 23:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants